Update User

AutomatR.AWS.Activities.UpdateUser

The "Update User" activity in AutomatR is part of the AWS Identity and Access Management (IAM) activities package, designed to update specified IAM users efficiently. This activity allows users to modify attributes such as the user name, path, tags, and permissions boundary, streamlining user management tasks within the AWS environment.

Properties

Name	Description
Input
Access Key ID	Provides the encrypted access key ID for your AWS account, enabling connection to the Amazon Recognition service. String variables containing the access key ID.
Name	Specifies the name of the IAM user that you want to update. String variables containing the user name.
New Name	Specifies the new name for the IAM user. String variables containing the new user name.
Path	Specifies the new path at which the IAM user should be updated and assigned for further use. String variables containing the path.
Region	Specifies the desired region in which you would like to update the IAM user. RegionEndpoint variables containing the AWS region.
Secret Access Key	Provides the encrypted secret access key ID for your AWS account, enabling connection to the Amazon Recognition service. String variables containing the secret access key.
Tags To Add	Specifies the tags that need to be added or updated. Stored in the form of a Dictionary<string, string> variable.
Tags To Remove	Provide a List<string> variable to store the keys of the tags that you want to remove.
New Permissions Boundary ARN	Provide the new ARN boundary that you want to set as the new permission boundary for the IAM user. String variables containing the ARN.
Delete Permissions Boundary	If checked, allows you to delete the permissions boundary for the IAM user. Boolean variables to enable or disable deletion.
Misc
Display Name	Provides a customizable name for the activity displayed in the workflow. The display name enhances clarity and organization within the automation project. String variables containing the desired display name.
Optional
Delay	Specifies the amount of time (in seconds) to wait before executing the "Update User" activity. This can be useful for handling synchronization issues. Integer variables containing the delay duration. Example: If the amount of time is 1000 milliseconds or 1 sec, i.e., 1.
Output
Result	Outputs the result of the "Update User" operation, indicating whether the user update was successful or encountered errors. Variables of relevant types (e.g., Boolean variables) to store the operation result.

How to use:

1. Drag and drop the "Update User" activity onto the workflow.
2. Configure the properties by providing the access key ID, secret access key, region, user name, new user name, and optional parameters such as path, tags, and permissions boundary.
3. Optionally, configure the delay and customize the display name.
4. Execute the workflow to update the specified IAM user.

Example: Consider an example where the "Update User" activity is used to update an IAM user named "JohnDoe" to a new name "JaneDoe" with additional tags and a custom path:

Update User:
  Display Name: "Update IAM User"
  Access Key ID: "{YourAccessKey}"
  Secret Access Key: "{YourSecretKey}"
  Region: "us-east-1"
  Name: "JohnDoe"
  New Name: "JaneDoe"
  Path: "/CustomPath/"
  Tags To Add: {"Department":"Engineering", "Role":"Developer"}
  Tags To Remove: {"Role"}
  New Permissions Boundary ARN: "arn:aws:iam::account-id:policy/CustomBoundary"
  Delete Permissions Boundary: false
  Result: isUpdateSuccessful

In this example, the activity updates the IAM user named "JohnDoe" to "JaneDoe" within the specified custom path "/CustomPath/" in the "us-east-1" region. It adds new tags ("Department" and "Role") and removes the existing "Role" tag. The new permissions boundary ARN is set, and the result of the operation is stored in the Boolean variable "isUpdateSuccessful" for further processing.